Skip to main content

/refund

Request body:

FieldTypeRequiredFormat / constraints
documentIDinteger (int64)NoInternal document id
documentExtIDstringNoExternal document id
docTimestringNoyyyy-MM-dd HH:mm:ss
docNumberstringNoExternal document number
employeeNamestringNoCashier name
employeeFirstNamestringNoUsed when employeeName is empty
employeeLastNamestringNoUsed when employeeName is empty
itemsarray of item objectsYesMust be non-empty
paymentsobjectNoPayment split object
extraPaymentsarray of extra payment objectsNoAdditional payment entries; also splits one refund between several payments of the same type — see §7.14
parentDocIDstringNoOriginal sale fiscal id; alias: parentFiscalID
parentDocNumstringNoOriginal sale fiscal number; alias: parentFiscalNum
extraParamsobject (string → string)NoExtra fields stored on the document and passed to the fiscal core as-is
genPreviewbooleanNoIf true, requests a fiscal receipt preview (see preview_data in the response)

documentExtID is schema-optional but strongly recommended for every request, same as for /sale — see §12.1.

Success response: same field set and value rules as /sale.

[!NOTE] Notes: /refund does not support document-level fields discount, discountPrc, discountName.